Apple Developer Connection Student Program/ADC Tools Sampler CD Disk 3 1999.iso/Metrowerks CodeWarrior/Java Support/Java_Source/Java2/src/java/security/AccessControlContext.java

Java Source | 1999-05-28 | 12.7 KB | 482 lines | [TEXT/CWIE]

/*
 * @(#)AccessControlContext.java    1.22 98/07/20
 *
 * Copyright 1997, 1998 by Sun Microsystems, Inc.,
 * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
 * All rights reserved.
 *
 * This software is the confidential and proprietary information
 * of Sun Microsystems, Inc. ("Confidential Information").  You
 * shall not disclose such Confidential Information and shall use
 * it only in accordance with the terms of the license agreement
 * you entered into with Sun.
 */

package java.security;

import java.util.Vector;
import sun.security.util.Debug;

/**
 * An AccessControlContext is used to make system resource access decisions
 * based on the context it encapsulates.
 *
 * <p>More specifically, it encapsulates a context and
 * has a single method, <code>checkPermission</code>,
 * that is equivalent to the <code>checkPermission</code> method
 * in the AccessController class, with one difference: The AccessControlContext
 * <code>checkPermission</code> method makes access decisions based on the
 * context it encapsulates,
 * rather than that of the current execution thread.
 *
 * <p>Thus, the purpose of AccessControlContext is for those situations where
 * a security check that should be made within a given context
 * actually needs to be done from within a
 * <i>different</i> context (for example, from within a worker thread).
 *
 * <p> An AccessControlContext is created by calling the
 * <code>AccessController.getContext</code> method.
 * The <code>getContext</code> method takes a "snapshot"
 * of the current calling context, and places
 * it in an AccessControlContext object, which it returns. A sample call is
 * the following:
 *
 * <pre>
 *
 *   AccessControlContext acc = AccessController.getContext()
 *
 * </pre>
 *
 * <p>
 * Code within a different context can subsequently call the
 * <code>checkPermission</code> method on the
 * previously-saved AccessControlContext object. A sample call is the
 * following:
 *
 * <pre>
 *
 *   acc.checkPermission(permission)
 *
 * </pre>
 *
 * @see AccessController
 *
 * @author Roland Schemers
 */

public final class AccessControlContext {

    private ProtectionDomain context[];
    private boolean isPrivileged;
    private AccessControlContext privilegedContext;

    private static boolean debugInit = false;
    private static Debug debug = null;

    static Debug getDebug()
    {
    if (debugInit)
        return debug;
    else {
        if (Policy.isSet()) {
        debug = Debug.getInstance("access");
        debugInit = true;
        }
        return debug;
    }
    }

    /**
     * Create an AccessControlContext with the given set of ProtectionDomains.
     * Context must not be null. Duplicate domains will be removed from the
     * context.
     *
     * @param context the ProtectionDomains associated with this context.
     */

    public AccessControlContext(ProtectionDomain context[])
    {
    if (context.length == 1) {
        this.context = (ProtectionDomain[])context.clone();
    } else {
        Vector v = new Vector(context.length);
        for (int i =0; i< context.length; i++) {
        if ((context[i] != null) &&  (!v.contains(context[i])))
            v.addElement(context[i]);
        }
        this.context = new ProtectionDomain[v.size()];
        v.copyInto(this.context);
    }
    }

    /**
     * package private constructor for AccessController.getContext()
     */

    AccessControlContext(ProtectionDomain context[],
                 boolean isPrivileged)
    {
    this.context = context;
    this.isPrivileged = isPrivileged;
    }

    /**
     * Returns true if this context is privileged.
     */
    boolean isPrivileged()
    {
    return isPrivileged;

    }

    /**
     * Determines whether the access request indicated by the
     * specified permission should be allowed or denied, based on
     * the security policy currently in effect, and the context in
     * this object.
     * <p>
     * This method quietly returns if the access request
     * is permitted, or throws a suitable AccessControlException otherwise.
     *
     * @param perm the requested permission.
     *
     * @exception AccessControlException if the specified permission
     * is not permitted, based on the current security policy and the
     * context encapsulated by this object.
     */

    public void checkPermission(Permission perm)
         throws AccessControlException
    {
    if (getDebug() != null) {
        if (Debug.isOn("stack"))
            Thread.currentThread().dumpStack();
        if (Debug.isOn("domain")) {
        if (context == null) {
            debug.println("domain (context is null)");
        } else {
            for (int i=0; i< context.length; i++) {
            debug.println("domain "+i+" "+context[i]);
            }
        }
        }
    }

    /*
     * iterate through the ProtectionDomains in the context.
     * Stop at the first one that doesn't allow the
     * requested permission (throwing an exception).
     *
     */

    /* if ctxt is null, all we had on the stack were system domains,
       or the first domain was a Privileged system domain. This
       is to make the common case for system code very fast */

    if (context == null)
        return;

    for (int i=0; i< context.length; i++) {
        if (context[i] != null &&  !context[i].implies(perm)) {
        if (debug != null) {
            debug.println("access denied "+perm);
            if (Debug.isOn("failure")) {
            Thread.currentThread().dumpStack();
            final ProtectionDomain pd = context[i];
            final Debug db = debug;
            AccessController.doPrivileged (new PrivilegedAction() {
                public Object run() {
                db.println("domain that failed "+pd);
                return null;
                }
            });
            }
        }
        throw new AccessControlException("access denied "+perm, perm);
        }
    }

    // allow if all of them allowed access
    if (debug != null)
        debug.println("access allowed "+perm);

    return;
    }

    /**
     * Take the stack-based context (this) and combine it with
     * the privileged context. this method will only be called
     * if privilegedContext is non-null.
     */
    AccessControlContext combineWithPrivilegedContext()
    {
    // this.context could be null if only system code is on the stack
    // in that case, ignore the stack context
    boolean skipStack = (context == null);

    AccessControlContext pacc = privilegedContext;
    boolean skipPrivileged = (pacc.context == null);

    if (skipPrivileged && skipStack) {
        return this;
    }

    int slen = (skipStack) ? 0 : context.length;

    // optimization: if the length is less then or equal to two,
    // there is no reason to compress the stack context, it already is
    if (skipPrivileged && slen <= 2)
        return this;

    int plen = (skipPrivileged) ? 0 : pacc.context.length;

    // optimization: if the length is less then or equal to two,
    // there is no reason to compress the priv context, it already is
    if (skipStack && plen <= 2)
        return pacc;

    // optimization: case where we have a length of 1 and
    // protection domains for priv context and stack are equal
    if ((slen == 1) && (plen == 1) && (context[0] == pacc.context[0]))
        return this;

    // now we combine both of them, and create a new context.
    ProtectionDomain pd[] = new ProtectionDomain[slen + plen];

    int i, j, n;

    n = 0;

    // first add all the protection domains from the stack context,
    // throwing out nulls and duplicates

    if (!skipStack) {
        for (i = 0; i < context.length; i++) {
        boolean add = true;
        for (j= 0; (j < n) && add; j++) {
            add = (context[i] != null) && (context[i] != pd[j]);
        }
        if (add) {
            pd[n++] = context[i];
        }
        }
    }

    // now add all the protection domains from the priv context,
    // throwing out nulls and duplicates

    if (!skipPrivileged) {
        for (i = 0; i < pacc.context.length; i++) {
        boolean add = true;
        for (j= 0; (j < n) && add; j++) {
            add = (pacc.context[i] != null) &&
            (pacc.context[i] != pd[j]);
        }
        if (add) {
            pd[n++] = pacc.context[i];
        }
        }
    }

    // if length isn't equal, we need to shorten the array
    if (n != pd.length) {
        // if all we had were system domains, context is null
        if (n == 0) {
        pd = null;
        } else {
        ProtectionDomain tmp[] = new ProtectionDomain[n];
        System.arraycopy(pd, 0, tmp, 0, n);
        pd = tmp;
        }
    }

    return new AccessControlContext(pd, true);
    }


    /**
     * Take the stack-based context (this) and combine it with
     * the inherited context, if need be.
     */
    AccessControlContext optimize()
    {
    // this.context could be null if only system code is on the stack
    // in that case, ignore the stack context

    boolean skipStack = (context == null);

    // if this context is privileged,
    // or if tacc is null, or if tacc.context is null,
    // don't do the thread context

    boolean skipThread;
    AccessControlContext tacc;

    if (isPrivileged) {
        if (privilegedContext != null)
        return combineWithPrivilegedContext();
        else {
        skipThread = true;
        tacc = null;
        }
    } else {
        tacc = AccessController.getInheritedAccessControlContext();
        skipThread = (tacc == null) || (tacc.context == null);
    }

    if (skipThread && skipStack) {
        return this;
    }

    int slen = (skipStack) ? 0 : context.length;

    // optimization: if the length is less then or equal to two,
    // there is no reason to compress the stack context, it already is
    if (skipThread && slen <= 2)
        return this;

    int tlen = (skipThread) ? 0 : tacc.context.length;

    // optimization: if the length is less then or equal to two,
    // there is no reason to compress the thread context, it already is
    if (skipStack && tlen <= 2)
        return tacc;

    // optimization: case where we have a length of 1 and
    // protection domains for thread and stack are equal
    if ((slen == 1) && (tlen == 1) && (context[0] == tacc.context[0]))
        return this;

    // now we combine both of them, and create a new context.
    ProtectionDomain pd[] = new ProtectionDomain[slen + tlen];

    int i, j, n;

    n = 0;

    // first add all the protection domains from the stack context,
    // throwing out nulls and duplicates

    if (!skipStack) {
        for (i = 0; i < context.length; i++) {
        boolean add = true;
        for (j= 0; (j < n) && add; j++) {
            add = (context[i] != null) && (context[i] != pd[j]);
        }
        if (add) {
            pd[n++] = context[i];
        }
        }
    }

    // now add all the protection domains from the inherited context,
    // throwing out nulls and duplicates

    // only do if stack context is not privileged, and the thread context
    // is not null.

    if (!skipThread) {
        for (i = 0; i < tacc.context.length; i++) {
        boolean add = true;
        for (j= 0; (j < n) && add; j++) {
            add = (tacc.context[i] != null) &&
            (tacc.context[i] != pd[j]);
        }
        if (add) {
            pd[n++] = tacc.context[i];
        }
        }
    }

    // if length isn't equal, we need to shorten the array
    if (n != pd.length) {
        // if all we had were system domains, context is null
        if (n == 0) {
        pd = null;
        } else {
        ProtectionDomain tmp[] = new ProtectionDomain[n];
        System.arraycopy(pd, 0, tmp, 0, n);
        pd = tmp;
        }
    }

    // the new context is privileged if either one of the contexts
    // was privileged. XXX: is this right?

    return new AccessControlContext(pd, isPrivileged || tacc.isPrivileged);
    }

    /**
     * Checks two AccessControlContext objects for equality.
     * Checks that <i>obj</i> is
     * an AccessControlContext and has the same set of ProtectionDomains
     * as this context.
     * <P>
     * @param obj the object we are testing for equality with this object.
     * @return true if <i>obj</i> is an AccessControlContext, and has the
     * same set of ProtectionDomains as this context, false otherwise.
     */
    public boolean equals(Object obj) {
    if (obj == this)
        return true;

    if (! (obj instanceof AccessControlContext))
        return false;

    AccessControlContext that = (AccessControlContext) obj;


    if (context == null) {
        return (that.context == null);
    }

    if (that.context == null)
        return false;

    boolean match;
    for (int i = 0; i < this.context.length; i++) {
        match = false;
        for (int j = 0; (j < that.context.length) && !match; j++) {
        match =
            ((this.context[i] == null) && (that.context[j] == null)) ||
            (this.context[i].equals(that.context[j]));
        }
        if (!match) return false;
    }

    match = false;
    for (int i = 0; i < that.context.length; i++) {
        match = false;
        for (int j = 0; (j < this.context.length) && !match; j++) {
        match =
            ((that.context[i] == null) && (this.context[j] == null)) ||
            (that.context[i].equals(this.context[j]));
        }
        if (!match) return false;
    }
    return true;

    }

    /**
     * Returns the hash code value for this context. The hash code
     * is computed by exclusive or-ing the hash code of all the protection
     * domains in the context together.
     *
     * @return a hash code value for this context.
     */

    public int hashCode() {
    int hashCode = 0;

    if (context == null)
        return hashCode;

    for (int i =0; i < context.length; i++) {
        if (context[i] != null)
        hashCode ^= context[i].hashCode();
    }
    return hashCode;
    }
}